Skip to content

#1: validate required workflows usage across repositories#6

Draft
tlamonthezie wants to merge 21 commits intomasterfrom
1-validate-required-workflows-usage-across-repositories
Draft

#1: validate required workflows usage across repositories#6
tlamonthezie wants to merge 21 commits intomasterfrom
1-validate-required-workflows-usage-across-repositories

Conversation

@tlamonthezie
Copy link
Collaborator

@tlamonthezie tlamonthezie commented Dec 19, 2024 •
edited by cwschilly
Loading

Fixes #1

Checks that every non-forked DARMA-tasking repository includes workflows in .github/workflow that use the following actions:

action-git-diff-check
check-commit-format
check-pr-fixes-issue
find-trailing-whitespace
find-unsigned-commits

@tlamonthezie tlamonthezie self-assigned this Dec 19, 2024
@cwschilly cwschilly force-pushed the 1-validate-required-workflows-usage-across-repositories branch from 0a30b00 to db017eb Compare January 6, 2025 14:36
@cwschilly cwschilly self-assigned this Jan 6, 2025
@cwschilly cwschilly force-pushed the 1-validate-required-workflows-usage-across-repositories branch from 8ad355d to 3e43c5f Compare January 6, 2025 16:06
@cwschilly
Copy link
Contributor

cwschilly commented Jan 6, 2025

This PR adds a check for all non-forked DARMA-tasking repos to make sure they include the required workflows.

The follow repos fail the check:

No Workflows Directory
 - vt-sample-project
 - parallel-for-transformer

Missing All Workflows:
 - detector (deprecated)

Missing action-git-diff-check
 - magistrate
 - comment-on-pr

I will update the workflow to ignore any of these that we don't care about, but I want to make sure we're all on the same page before I do so. My suggestion is to add the missing check to both magistrate and comment-on-pr, and then ignore the rest.

@nlslatt @lifflander @ppebay What do you think?

@ppebay
Copy link

ppebay commented Jan 6, 2025

This PR adds a check for all non-forked DARMA-tasking repos to make sure they include the required workflows.

The follow repos fail the check:

No Workflows Directory
 - vt-sample-project
 - parallel-for-transformer

Missing All Workflows:
 - detector (deprecated)

Missing action-git-diff-check
 - magistrate
 - comment-on-pr

I will update the workflow to ignore any of these that we don't care about, but I want to make sure we're all on the same page before I do so. My suggestion is to add the missing check to both magistrate and comment-on-pr, and then ignore the rest.

@nlslatt @lifflander @ppebay What do you think?

I agree with your suggestion @cwschilly but will defer to @nlslatt and @lifflander for final decision.

@lifflander
Copy link
Contributor

lifflander commented Jan 6, 2025

I will update the workflow to ignore any of these that we don't care about, but I want to make sure we're all on the same page before I do so. My suggestion is to add the missing check to both magistrate and comment-on-pr, and then ignore the rest.

Yes, that sounds good to me.

@cwschilly cwschilly marked this pull request as ready for review January 6, 2025 20:12
@cwschilly cwschilly force-pushed the 1-validate-required-workflows-usage-across-repositories branch 2 times, most recently from 5159d66 to 39dabba Compare January 6, 2025 21:09
ppebay
ppebay reviewed Jan 7, 2025
View reviewed changes
ci/list_repositories.sh
"DARMA-tasking.github.io",
"find-unsigned-commits",
"check-commit-format",
"find-trailing-whitespace",
Copy link

@ppebay ppebay Jan 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is trailing WS finder excluded?

Copy link
Contributor

@cwschilly cwschilly Jan 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

find-unsigned-commits, check-commit-format, check-pr-fixes-issue, and find-trailing-whitespace are the actions that we're looking for in other DARMA-tasking repos. Since they don't run themselves (or any of the other actions), we can exclude them all from the check.

ppebay
ppebay reviewed Jan 7, 2025
View reviewed changes
.github/workflows/check-repositories.yml Outdated
# Run on the first day of the month
on:
schedule:
- cron: '0 0 1 * *'
Copy link

@ppebay ppebay Jan 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am confused by the cron values, could you put a comment to explain them for future reference? Thanks

Copy link
Contributor

@cwschilly cwschilly Jan 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the comment; let me know if it is clear now.

@cwschilly cwschilly marked this pull request as draft January 7, 2025 18:59
@cwschilly cwschilly force-pushed the 1-validate-required-workflows-usage-across-repositories branch 2 times, most recently from dd8913a to f5acb76 Compare January 7, 2025 20:13
@cwschilly cwschilly force-pushed the 1-validate-required-workflows-usage-across-repositories branch from 78e70a9 to fbecf8c Compare January 9, 2025 16:39
@cwschilly cwschilly mentioned this pull request Jan 9, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ppebay ppebay ppebay left review comments

@cwschilly cwschilly cwschilly left review comments

@lifflander lifflander Awaiting requested review from lifflander

@nlslatt nlslatt Awaiting requested review from nlslatt

At least 1 approving review is required to merge this pull request.

Assignees

@tlamonthezie tlamonthezie

@cwschilly cwschilly

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

#1: validate required workflows usage across repositories

4 participants

@tlamonthezie @cwschilly @ppebay @lifflander